home *** CD-ROM | disk | FTP | other *** search
/ Tech Arsenal 1 / Tech Arsenal (Arsenal Computer).ISO / tek-13 / aled153.zip / ALED.DOC < prev    next >
Text File  |  1990-04-21  |  19KB  |  508 lines
  1.  
  2.                     ALed 1.5 -=- ALan's Text Editor Documentation
  3.                    ==============================================
  4.  
  5.  
  6.        ALed is a small powerful, programmers editor that was designed to
  7.        be suitable for most, if not all, of your text editing needs.
  8.  
  9.        FEATURES
  10.        ~~~~~~~~
  11.               -> POP-UP ASCII Table (moveable w/ arrow, pg & space keys)
  12.               -> POP-UP 3 Display 32 bit Calculator (Bin/Hex/Dec) (moveable)
  13.                  with logical operations. (+,-,*,/,and,or,not,xor,shift,mod)
  14.               -> Bracket Matching {} () [] <>
  15.               -> 10 MACRO Registers (record, execute, save, load, print)
  16.               -> UnDelete Lines
  17.               -> Multiple Buffers (As many as memory permits)
  18.               -> 10 Text Registers (for cut and paste)
  19.               -> Insert/Overstrike Editing
  20.               -> Load Multiple Files at the Command line
  21.               -> Search/Replace across all active buffers
  22.               -> Search/Replace Direction & Case Sensitivity Toggles
  23.               -> Ooops. Replace Back
  24.               -> Goto Line number
  25.               -> Goto Previous Lines (last 150 positions)
  26.               -> DOS Shell
  27.               -> DOS Commands (Nice for compilation)
  28.               -> Delete Word, Line, Register, Block, Buffer
  29.               -> Online Help
  30.               -> Constant Memory Display
  31.               -> Smart Indentation (toggled)
  32.               -> On-Screen Clock with Date & Time  (Removable)
  33.               -> Block Read (File Insert)
  34.               -> Block Write (Redirectable)
  35.               -> Graphic Characters
  36.               -> Buffer Printing
  37.               -> Split Screens
  38.               -> Buffer Rename
  39.               -> Directory/Subdirectory Support
  40.               -> File/Buffer Picklist
  41.               -> Adjustable TABS
  42.               -> Hex/Dec/Char Keypress Display
  43.               -> Redirectable I/O (CON/LPT/PRN/COM)
  44.               -> Snow Removal Toggle
  45.  
  46.        SYSTEM REQUIREMENTS
  47.        ~~~~~~~~~~~~~~~~~~~
  48.        ALed requires 256K of RAM,  a form of mass storage and an 80x25
  49.        Text monitor (Mono/CGA/EGA/VGA).
  50.  
  51.        For best results, I would use a system with over 256K and Color monitor
  52.  
  53.  
  54.        USING ALed
  55.        ~~~~~~~~~~
  56.  
  57.        To run Aled, Type "ALed <file1> <file2> <file3>....<filen>" and hit
  58.        return.
  59.  
  60.        If Aled finds the file, it will load it in memory, and load any
  61.        remaining files. However, if a file is not found, then Aled will
  62.        initialize a buffer with the file name. If no files are specified
  63.        at the command line, then ALed will initialize a buffer named
  64.        "NONAME". (Note: Buffers are easily removed or renamed )
  65.  
  66.         At this point you can begin entering your text, however, when you
  67.         want to save, you will be prompted to enter a new file name.
  68.  
  69.         Loading Files
  70.         ~~~~~~~~~~~~~
  71.         To load another file, press F3. You will see the current path
  72.         ( example C:\TC\PROG\ ) displayed and you will be prompted to enter
  73.         the file name to load. If you wish see a directory, press enter and
  74.         then use the arrow keys to select the file or change the directory.
  75.         If you wish change the path from the prompt, type in the entire path
  76.         and press return. (Ex: "C:\TC\PROG\").
  77.         If you wish to change drives, enter the drive specifier (C: or A: etc)
  78.         and ALed will load the picklist with the new drive's directory entries.
  79.         To open a new blank Buffer, Press ALT F3 and enter the new buffer name.
  80.  
  81.         Saving Files
  82.         ~~~~~~~~~~~~
  83.         To save the current file you are working on and remove it from the
  84.         working buffer, press F2. To save and Keep the file in memory, press
  85.         ALT F2.
  86.  
  87.         Searching/Replacing:
  88.         ~~~~~~~~~~~~~~~~~~~~
  89.         ALed contains two types of searches. Search and Search and Replace. To
  90.         search for text enter the search command (Alt-S Default) and then 
  91.         enter the search string. 
  92.         To search for text using ALed, press ALT+S and you will be prompted
  93.         for the text to search the buffer for. After you enter the search
  94.         string, ALed will search the buffer from the current line Downward
  95.         (Default) to the End of the Buffer.
  96.  
  97.  
  98.         Note: On the Status Line there are 2 Search Conditions. When ALed 
  99.         starts up, you will see an "IAsD" displayed on the Status Line.
  100.  
  101.            The I is for Insert mode
  102.                O is for Overstrike when toggled (INSERT)
  103.            The A is for AutoIndent
  104.                  Turned off when Toggled (ALT+I)
  105.            The s is for case significance during searches
  106.                S for Ignore Case when toggles (CTL+S)
  107.            The D is search Direction (Down)
  108.                U when Toggle (CTL+D)
  109.  
  110.         If the text is found, ALed will position the cursor at the found text.
  111.         If the text is not found, ALed will display "**** Not Found ****" on
  112.         the message line.
  113.  
  114.         You can toggle the direction and/or the case sensitivity of the search
  115.         and press ALT+A to attempt the search again, or you can press ALT+S
  116.         again and re-edit your search string for another attempt.
  117.  
  118.         The Search and Replace Function work similarly.
  119.  
  120.  
  121.        THE SCREEN
  122.        ~~~~~~~~~~
  123.  
  124.        Most of Aled's screen is used solely for displaying buffer data,
  125.        however there are two lines to be aware of.
  126.  
  127.        Status Line:
  128.  
  129.        This is the last line on the display screen and it constantly displays
  130.        the status for the buffer currently being edited. Displayed are
  131.        (from left to right) Current Line number, Total Number of lines, Column
  132.        position of the cursor, Memory available, and the name of the file or
  133.        buffer currently displayed.
  134.  
  135.        When ALed starts up, there is a 'IAsD' Displayed on this line.
  136.  
  137.        The I is for Insert mode
  138.            O is for Overstrike when toggled (INSERT)
  139.        The A is for AutoIndent
  140.              Turned off when Toggled (ALT+I)
  141.        The s is for case significance during searches
  142.            S for Ignore Case when toggles (CTL+S)
  143.        the D is search Direction (Down)
  144.            U when Toggle (CTL+D)
  145.  
  146.  
  147.         Using the 3 Display Calculator
  148.         ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  149.         One of the best features of ALed is it's unique programmers calculator
  150.         I've always wanted to be able to enter a value and instantly see all
  151.         of the BIN/HEX/DEC values displayed.
  152.  
  153.         Press ALT+C to invoke the popup calculator. If you wish to move the 
  154.         calculator around the screen, use the arrow keys for single space 
  155.         moves. Home,PageUp,End,PageDown move the calculator to the farthest 
  156.         corners of the screen, and SpaceBar to place the calculator in the 
  157.         center of the screen.
  158.  
  159.         This calculator in a NON-RPN type calculator. Meaning, it operates
  160.         just like an average hand-held calculator.
  161.         Enter a number, then enter a operator, then enter another number.
  162.         Then, you can:
  163.                 Press return for the sum
  164.                 Press '=' for the sum
  165.                 Enter another operator to continue calculating using the
  166.                 previous sum.
  167.  
  168.         Example: (1+(8*((54.0532/2)-9))) = ???
  169.  
  170.         enter        "54.0523"
  171.         enter         '/'
  172.         enter        '2'
  173.         enter         '-'
  174.         enter         '9'
  175.         enter        '*'
  176.         enter         '8'
  177.         enter        '+'
  178.         enter        '1'
  179.         enter        '=' or RETURN
  180.  
  181.         (1+(8*((32/54.0532)-9))) = 145.2128
  182.  
  183.         Using the ASCII Table
  184.         ~~~~~~~~~~~~~~~~~~~~~
  185.         Another useful programmers tool is the POP-UP ASCII Table.
  186.         To invoke this, Enter ALT+T.
  187.         to see other values, use the Up and Down arrow Keys. To
  188.         move the table, use the Left and Right Arrow keys.
  189.         Use the HOME or PGUP to move the table to the corners of the screen,
  190.         or, use SPACE to move the table to the center of the screen
  191.  
  192.         Message Line:
  193.  
  194.         One line up from the Status Line is the message line. This is the only
  195.         line that will display any messages or prompt.
  196.  
  197.  
  198.         Splitting The Screen:
  199.  
  200.         Another useful feature of ALed is it's split screen editing capability.
  201.         To Split the Screen, move the cursor to the line you want to be the
  202.         Last Line in the top window and Press ALT+O (open). The you can edit
  203.         your file normally using all of ALed's Commands. To Close the window
  204.         Press ALT+O again and the screen with the cursor in it will become the
  205.         full screen.
  206.  
  207.         To Jump from Screen to Screen, Press ALT+J. The cursor will then Jump
  208.         to the current line in the other screen.
  209.  
  210.         Note: If your system has a CGA Adaptor and you see "Snow" press
  211.               ALT+N to Toggle Snow Checking
  212.  
  213.  
  214.  
  215.        THE CURSOR
  216.        ~~~~~~~~~~
  217.  
  218.        ALed contains two distinct types of cursors, insert and overstrike.
  219.        Whenever the insert key is toggled, the current state is display
  220.        and the shape of the cursor is altered.
  221.  
  222.                           Box  = Insert Mode Active
  223.                           Line = Overstrike Mode Active
  224.  
  225.  
  226.  
  227.        BUFFERS
  228.        ~~~~~~~
  229.        Aled has the capability to load multiple files in memory at one time.
  230.        This is a great feature if you are working on a program with many
  231.        different source files. The number of buffers available is determined
  232.        only by the amount of memory in the system.
  233.  
  234.        Each Buffer is a self contained environment. Basically, that means
  235.        any changes (current cursor position etc) made to one buffer will
  236.        NOT affect any other buffers in memory. The only features that are
  237.        available globally between all buffers are the Search, the Search
  238.        and Replace, the Cut & Paste, and the block print/save features.
  239.        These features allow you to search, replace, and copy and move text
  240.        between buffers.
  241.  
  242.        TEXT REGISTERS
  243.        ~~~~~~~~~~~~~~
  244.  
  245.        ALed can use up to 10 text registers for storing data copied or moved
  246.        from one of the buffers. This is useful for cutting out a lot of
  247.        data from many places in the same buffer or different buffers and
  248.        pasting in another buffer(s).
  249.  
  250.  
  251.        COMMAND SUMMARY
  252.        ~~~~~~~~~~~~~~~
  253.        
  254.         Cursor Movement:
  255.  
  256.        -->            Move cursor right. If end of line move to column 1 of
  257.                       next line.
  258.  
  259.        <--            Move cursor Left. If beginning of line, move to end of
  260.                       previous line.
  261.  
  262.        CTL+->         Move to beginning of Next word. If end of line move
  263.                       to column 1 of next line.
  264.  
  265.        CTL+<-         Move to beginning of previous word. If beginning of
  266.                       line, move to end of previous line
  267.  
  268.        Up Arrow       Move up one line
  269.  
  270.        Dwn Arrow      Move down one line
  271.  
  272.        PGUP           Move up one page
  273.  
  274.        PGDWN          Move down one page
  275.  
  276.        CTL+PGUP       Move up   1/2 Page
  277.  
  278.        CTL+PGDWN      Move down 1/2 Page
  279.  
  280.        HOME           Move to Column 1. If at column 1, then move to column 1
  281.                       of previous line
  282.  
  283.        CTL+HOME       Move to top of Buffer
  284.  
  285.        END            Move to last character in line. If at End Of Line then
  286.                       move to end of next line.
  287.  
  288.        CTL+END        Move to bottom of buffer
  289.        
  290.        ALT+G          Goto Line Number
  291.        CTL+G          Goto Last Lines (last 150 lines)
  292.        
  293.         
  294.         Insert/Delete:        
  295.  
  296.        INS            Toggle Insert/Overstrike
  297.        DEL            Delete character at cursor
  298.        BS             Delete previous character. If at Beginning of Line,
  299.                       Join Lines
  300.        CTL+W          Delete Current Word
  301.        CTL+E          Delete to Beginning of Line
  302.        ALT+E          Delete to End of Line
  303.        ALT+D          Display Delete Menu
  304.        ALT+L          Delete Current Line
  305.        ALT+U          Un-Delete Lines (Also from Block Deletes)
  306.        
  307.  
  308.  
  309.        COMMAND SUMMARY cont.
  310.        ~~~~~~~~~~~~~~~
  311.        
  312.         Search/Replace:
  313.  
  314.        Alt+S          Search for Text
  315.        Alt+A          Search Again
  316.        CTL+S          Case Significant/Case Insigificant in Searches
  317.        CTL+D          Search Direction Toggle (Up/Down)
  318.        
  319.  
  320.         Misc Commands:        
  321.  
  322.        ALT+R          Rename Current Buffer
  323.  
  324.        ALT+C          POP-UP 3 Display Programmers Calculator
  325.                        (use arrow keys to move calculator)
  326.        ALT+T          POP-UP ASCII Table (use arrow keys to move table)
  327.  
  328.        ALT+X or
  329.        CTL+C          Quick Exits
  330.  
  331.  
  332.        ALT+K          On-Screen Clock On/Off Toggle
  333.        ALT+N          Toggle SNOW checking ON/OFF
  334.        ALT+B          Bracket Matching <>{}[](). Place Cursor at bracket to
  335.                       match and enter ALT+B.
  336.        ALT+V          Enter Next Character Verbatim
  337.                       
  338.         Macros:
  339.         
  340.        ALT+M          Macro Functions Menu (Define/Save/Load/Print macros)
  341.        ALT+1 to 9     Execute Defined Macro
  342.        
  343.  
  344.  
  345.        COMMAND SUMMARY cont.
  346.        ~~~~~~~~~~~~~~~
  347.        Function Keys:
  348.  
  349.        F1             Help Screen
  350.  
  351.        F2             Save buffer and remover
  352.  
  353.        Alt+F2         Save buffer and continue editing
  354.  
  355.        F3             Load File (At prompt press RET for Picklist)
  356.                       or enter file name or dir path to search
  357.        Shift+F3       Insert FIle
  358.        Alt+F3         Open Buffer
  359.  
  360.        F4             Remove buffer from memory
  361.  
  362.        F5             Search and Replace
  363.  
  364.        F6             Replace again
  365.  
  366.        ALT+F6         Oops. Replace back
  367.  
  368.        F7             Block Begin/End for Copy/Move/Delete/Save
  369.  
  370.        F8             Paste from Text Register
  371.  
  372.        ALT+F8         Kill Text Register
  373.  
  374.        F9             Next Buffer
  375.        ALT+F9         Previous Buffer
  376.        CTL+F9         Buffer Pick List (use arrow keys to select)
  377.  
  378.        F10            Execute a DOS Command
  379.        ALT+F10        DOS Shell
  380.  
  381.  
  382.  
  383.  
  384.                               SHAREWARE NOTICE
  385.                               ~~~~~~~~~~~~~~~~
  386.  
  387.        The Program and Documentation contained in this archive are
  388.                  Copyright (C)1989-1990 by Alan Boulanger
  389.  
  390.  
  391.        REGISTRATION and ORDERING
  392.        ~~~~~~~~~~~~~~~~~~~~~~~~~
  393.        ALed version 1.5 is being distributed as ShareWare. Non-Registered
  394.        users of ALed 1.5 are granted a limited license to use and evaluate
  395.        this product for a period of 30 (thirty) days free of charge on a
  396.        Trial basis. At the end of the Trial period you should either:
  397.  
  398.                1) Delete ALed and NOT use it.
  399.                               **  OR **
  400.                2) Support the ShareWare concept and become a Registered User
  401.  
  402.        To become a Registered User. The following fee schedule applies.
  403.  
  404.            1) Professional/Government Site Licensing. $110.00 (U.S.)
  405.            2) Individual Licences $37.00 (U.S.)
  406.            3) Students (Mail copy of Valid College I.D.) $18.50 (U.S.)
  407.  
  408.        As a Registered User, You will be receive one free Upgrade of
  409.        ALed, without the closing screen message, that contains a few 'extra'
  410.        features and be entitled to free support. 
  411.        Plus you will receive discounts on future ALed enhancements and be
  412.        notified of any changes.
  413.  
  414.        Fill out the Enclosed Order Form and send To:
  415.  
  416.                             Alan Boulanger
  417.                             11 Bartemus Trail #204
  418.                             Nashua, NH 03036
  419.                             (603) 886-1086
  420.  
  421.        And include your Name, Address, Phone Number, and preferred method
  422.        of delivery (Mail or Modem). If Modem, let me know the best time to
  423.        call. (Note: I will only upload at 1200 baud and above)
  424.  
  425.  
  426. ------------------------------------------------------------------------------
  427.  
  428.                         ALed Version 1.5 Order Form
  429.                         ~~~~~~~~~~~~~~~~~~~~~~~~~~~
  430.  
  431.                 Yes, I would like to register my copy of Aled.
  432.  
  433.      Please send me:
  434.  
  435.     ALed 1.5 Registered Version.............Corporate License: $110.00
  436.                                            Individual License: $ 37.00
  437.                                               Student License: $ 18.50
  438.                                            ----------------------------
  439.                                            Number of Copies   X  _____
  440.                                            ----------------------------
  441.                                               Total           $ ____.__
  442.  
  443.    Method of Payment : ( ) Check ( ) Money Order
  444.  
  445.    Preferred Method Of Delivery: ( ) U.S. Mail  ( ) Modem
  446.    Note:
  447.         Modem Restrictions: Continental U.S. at 1200 baud or greater
  448.  
  449.  
  450.    Name    : _____________________________________________
  451.  
  452.    Address : _____________________________________________
  453.  
  454.    City/St : _____________, __
  455.  
  456.    Zip code: ______-____
  457.  
  458.    If Modem checked:
  459.             Phone Number : (___) ___-____
  460.  
  461.             Time to Call    __:__:__ ( )Am ( )Pm
  462.  
  463.  
  464.     Send To:
  465.                             Alan Boulanger
  466.                             11 Bartemus Trail #204
  467.                             Nashua, NH 03036
  468.                             (603) 886-1086
  469.  
  470. ------------------------------------------------------------------------------
  471.  
  472.  
  473.  
  474.        DISCLAIMER
  475.        ~~~~~~~~~~
  476.  
  477.        There are no guarantees, implied or otherwise, offered with this
  478.        program.
  479.  
  480.  
  481.  
  482.        NOTES
  483.        ~~~~~
  484.        Please let me know about any problems you may have with Aled. Even
  485.        though Aled has been tested by many people, there is always the
  486.        possibilities of running into one of those sneaky bugs.
  487.  
  488.        Also, if there are any features that you would like to see in future
  489.        versions of ALed please contact me, and I will try to implement
  490.        your feature.
  491.        
  492.        Note: Custom Versions of Aled are Available. Please Contact me for
  493.        details.
  494.        
  495.        If you would like to contact me, I can be reached at:
  496.  
  497.              Mail           Alan Boulanger
  498.              ~~~~           11 Bartemus Trail #204
  499.                             Nashua, NH 03036
  500.              Phone          (603) 886-1086
  501.              ~~~~~
  502.  
  503.              GEnie          A.Boulanger
  504.              ~~~~~
  505.  
  506.        I hope you enjoy using ALed as much as I enjoyed writing it!
  507.        
  508.